Docs -> Reference (Major version consolidation) Base#436
Docs -> Reference (Major version consolidation) Base#436Ethan-Arrowood wants to merge 53 commits intomainfrom
Conversation
Ethan-Arrowood
changed the title
Ethan-Arrowood
force-pushed
the
major-version-reorg
branch
2 times, most recently
from
f64304b to
c8fd63c
Compare
Ethan-Arrowood
force-pushed
the
major-version-reorg
branch
from
c8fd63c to
78eca4b
Compare
Ethan-Arrowood
changed the title
- Temporarily disable local search plugin (will re-enable later) - Set onBrokenLinks to 'warn' to allow build during migration - Add /reference redirect page to handle versioned docs structure - Create index.md files for reference directories - Update sidebars to autogenerate from directory structure - Document temporary changes in project brief for future re-enablement The site now builds successfully and is ready for migration PRs. Broken link warnings are expected as content is migrated. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-docs.stage.harperfabric.com/pr-436 This preview will update automatically when you push new commits. |
* docs: migrate CLI section to v4 consolidated reference Migrated Harper CLI documentation from versioned_docs to new reference_versioned_docs/version-v4/cli/ structure following the v4 documentation consolidation plan. Files created: - reference_versioned_docs/version-v4/cli/overview.md - reference_versioned_docs/version-v4/cli/commands.md - reference_versioned_docs/version-v4/cli/operations-api-commands.md - reference_versioned_docs/version-v4/cli/authentication.md - migration-context/link-placeholders/cli-link-placeholders.md Key Features: Version Annotations - All 72 CLI operations now include "Available Since" information with complete version coverage: - 51 operations from v4.3.0 - 11 operations from v4.4.0 (SSH and certificate operations) - 3 data operations from v4.4.9 (insert, update, upsert) - 3 status operations from v4.6.0 - Individual operations from v4.7.2 and v4.7.3 Authentication Documentation - Corrected to explain Unix domain socket authentication for local operations (automatically authenticated as superuser). Detailed environment variable and command parameter methods for remote operations with security best practices. Operations API Commands - Complete operations table with all 72 operations categorized by function, command aliases, parameter formatting guidelines, and cross-references to related sections via tip callouts. Process Management - Documented PID file location at <ROOTPATH>/hdb.pid, clarified foreground/background behavior for commands, and updated dev mode features. Link Management - 12 internal CLI section links resolved using relative paths. ~96 cross-section TODO links documented for future resolution in cli-link-placeholders.md. Content Consolidation - Merged content from v4.1 through v4.7 with inline version annotations following Node.js documentation patterns. Migration approach: - Single consolidated v4 reference (no separate v4.1-v4.7 versions) - Inline version annotations for feature availability - TODO: prefix for cross-section links pending future migrations - Comprehensive source attribution in HTML comments - Learn guide links use /learn paths - Consistent use of 'harper' command throughout 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * fixup! docs: migrate CLI section to v4 consolidated reference * fixup! docs: migrate CLI section to v4 consolidated reference --------- Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-docs.stage.harperfabric.com/pr-436 This preview will update automatically when you push new commits. |
* docs: migrate GraphQL Querying section to v4 consolidated reference Generated with Claude Code (https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * fixup! docs: migrate GraphQL Querying section to v4 consolidated reference * fixup! fixup! docs: migrate GraphQL Querying section to v4 consolidated reference * Update reference_versioned_docs/version-v4/graphql-querying/overview.md Co-authored-by: Kris Zyp <kriszyp@gmail.com> * remove coming soon sections --------- Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com> Co-authored-by: Kris Zyp <kriszyp@gmail.com>
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-docs.stage.harperfabric.com/pr-436 This preview will update automatically when you push new commits. |
* docs: migrate Studio section to v4 consolidated reference Generated with Claude Code (https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * fixup! docs: migrate Studio section to v4 consolidated reference * fixup! docs: migrate Studio section to v4 consolidated reference * fixup! docs: migrate Studio section to v4 consolidated reference * fixup! docs: migrate Studio section to v4 consolidated reference * fixup! fixup! docs: migrate Studio section to v4 consolidated reference * docs: update plans to clarify Studio vs Harper Cloud Studio distinction * manual edits * edit credentials/authentication info * move additional cloud docs over per discussion * simplify legacy cloud * remove reference to cloud in studio docs. * update link placeholders doc --------- Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-docs.stage.harperfabric.com/pr-436 This preview will update automatically when you push new commits. |
* docs: migrate Fastify Routes section to v4 consolidated reference Generated with Claude Code (https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * fixup! docs: migrate Fastify Routes section to v4 consolidated reference * manual tweaks --------- Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-docs.stage.harperfabric.com/pr-436 This preview will update automatically when you push new commits. |
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-docs.stage.harperfabric.com/pr-436 This preview will update automatically when you push new commits. |
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-436 This preview will update automatically when you push new commits. |
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-436 This preview will update automatically when you push new commits. |
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-436 This preview will update automatically when you push new commits. |
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-436 This preview will update automatically when you push new commits. |
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-436 This preview will update automatically when you push new commits. |
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-436 This preview will update automatically when you push new commits. |
|
For posterity, I've pushed an archive of this branch that includes the planning documents to planning-docs-archive. This contains a retro on the work for a future blog post / talk. |
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-436 This preview will update automatically when you push new commits. |
|
For reviewers. We've already reasonably reviewed all content prior to merging them here. Due to complications with redirects, I had to remove the old docs files and create the v5 content too so I could get everything wired up. You can try reviewing commits or ranges; I tried my best to do things in an organized way, but I wasn't overly strict about it. Here are some aspects I recommend reviewing either via the preview deployment or by searching for the relative source content:
|
dawsontoth
left a comment
dawsontoth
left a comment
There was a problem hiding this comment.
I think the "added in" looks reasonable -- it could be lighter if we want, but it's already de-emphasized a good bit, IMO.
There was a problem hiding this comment.
This looks really nice, great layout, styling (version badge is perfect) and organization!
I think the only things I might move or adjust:
- I think REST querying page should be the first one after REST overview (in order of priority)
- I would like to have an page dedicated to introducing the host environment, the listing of the set of imports from harper, also accessible as global variables. But that is more of an addition that can come later.
- Probably would still prefer SQL listed under operations, partly because it puts it below the fold.
None of these should block merging, this looks really good.
I think the "added in" looks reasonable
The styling is great. What do you think about right align? (so it consumes less vertical space)
3 participants
This is the base branch for the major Docs to Reference migration and major version consolidation work.
Review the v4-* documents in the root for information on the project plan. Going to leverage agents to heavily automate this work but it will still involve lots of human-in-the-loop too.
Tracking migration of v4 documentation to consolidated structure.
Phase 1A - Simple Sections
Phase 1B - Medium Complexity
Phase 1C - Complex Sections
Phase 1D - Cross-Cutting
Phase 1E - Legacy
Part 2 - Link Resolution
Part 3 - Cross-References
Part 4 - Finalization
High level ideas from reviews: